
package org.apache.solr.request;

import java.util.Map;
import org.apache.solr.common.params.SolrParams;
import org.apache.solr.common.util.ContentStream;
import org.apache.solr.core.SolrCore;
import org.apache.solr.schema.IndexSchema;
import org.apache.solr.search.SolrIndexSearcher;

/**
 * <p>Container for a request to execute a query.</p>
 * <p><code>SolrQueryRequest</code> is not thread safe.</p>
 *
 *
 */
public interface SolrQueryRequest {

    /**
     * returns the current request parameters
     */
    public SolrParams getParams();

    /**
     * Change the parameters for this request. This does not affect
     * the original parameters returned by getOriginalParams()
     */
    public void setParams(SolrParams params);

    /**
     * A Collection of ContentStreams passed to the request
     */
    public Iterable<ContentStream> getContentStreams();

    /**
     * Returns the original request parameters. As this
     * does not normally include configured defaults
     * it's more suitable for logging.
     */
    public SolrParams getOriginalParams();

    /**
     * Generic information associated with this request that may be both read and updated.
     */
    public Map<Object, Object> getContext();

    /**
     * This method should be called when all uses of this request are
     * finished, so that resources can be freed.
     */
    public void close();

    /**
     * The start time of this request in milliseconds
     */
    public long getStartTime();

    /**
     * The index searcher associated with this request
     */
    public SolrIndexSearcher getSearcher();

    /**
     * The solr core (coordinator, etc) associated with this request
     */
    public SolrCore getCore();

    /**
     * The index schema associated with this request
     */
    public IndexSchema getSchema();

    /**
     * Returns a string representing all the important parameters.
     * Suitable for logging.
     */
    public String getParamString();
}
